Person.getFacts - Code Metrics - rootsdev/gedcomx-js - Measure and Improve Code Quality continuously with Scrutinizer

Person.getFacts A
last analyzed 2017-03-29 00:20 UTC

↳ Parent: src/core/Person.js

Complexity

Conditions	1
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	3
rs	10

var GedcomX = require('../'),
    utils = require('../utils');
    
/**
 * A person.
 * 
 * @see {@link https://github.com/FamilySearch/gedcomx/blob/master/specifications/json-format-specification.md#person|GEDCOM X JSON Spec}
 * 
 * @class
 * @extends Subject
 * @param {Object} [json]
 */
var Person = function(json){
  
  // Protect against forgetting the new keyword when calling the constructor
  if(!(this instanceof Person)){
    return new Person(json);
  }
  
  // If the given object is already an instance then just return it. DON'T copy it.
  if(Person.isInstance(json)){
    return json;
  }
  
  this.init(json);

};

Person.prototype = Object.create(GedcomX.Subject.prototype);

Person._gedxClass = Person.prototype._gedxClass = 'GedcomX.Person';

Person.jsonProps = [
  'private',
  'gender',
  'names',
  'facts'
];

/**
 * Check whether the given object is an instance of this class.
 * 
 * @param {Object} obj
 * @returns {Boolean}
 */
Person.isInstance = function(obj){
  return utils.isInstance(obj, this._gedxClass);
};

/**
 * Initialize from JSON
 * 
 * @param {Object}

 * @return {Person} this
 */
Person.prototype.init = function(json){
  
  GedcomX.Subject.prototype.init.call(this, json);
  
  if(json){
    this.setPrivate(json.private);
    this.setGender(json.gender);
    this.setNames(json.names);
    this.setFacts(json.facts);
  }
  return this;
};

/**
 * Get the private flag
 * 
 * @returns {Boolean} private
 */
Person.prototype.getPrivate = function(){
  return this.private;
};

/**
 * Set the private flag
 * 
 * @param {Boolean} isPrivate
 * @returns {Person} This instance
 */
Person.prototype.setPrivate = function(isPrivate){
  this.private = isPrivate;
  return this;
};

/**
 * Get the person's gender
 * 
 * @returns {Gender} gender
 */
Person.prototype.getGender = function(){
  return this.gender;
};

/**
 * Set the person's gender
 * 
 * @param {Gender} gender
 * @returns {Person} This instance
 */
Person.prototype.setGender = function(gender){
  if(gender){
    this.gender = GedcomX.Gender(gender);
  }
  return this;
};

/**
 * Check if the person's gender is male.
 * 
 * @returns {Boolean}
 */
Person.prototype.isMale = function(){
  return this.gender && this.gender.getType() === 'http://gedcomx.org/Male';
};

/**
 * Check if the person's gender is female.
 * 
 * @returns {Boolean}
 */
Person.prototype.isFemale = function(){
  return this.gender && this.gender.getType() === 'http://gedcomx.org/Female';
};

/**
 * Get the names
 * 
 * @return {Name[]}
 */
Person.prototype.getNames = function(){
  return this.names || [];
};

/**
 * Set the names
 * 
 * @param {Name[]|Object[]} names
 * @returns {Person} This instance
 */
Person.prototype.setNames = function(names){
  return this._setArray(names, 'names', 'addName');
};

/**
 * Add a name
 * 
 * @param {NameForm|Object} name
 * @returns {Person} This instance
 */
Person.prototype.addName = function(name){
  return this._arrayPush(name, 'names', GedcomX.Name);
};

/**
 * Get the facts
 * 
 * @return {Fact[]}
 */
Person.prototype.getFacts = function(){
  return this.facts || [];
};

/**
 * Set the facts
 * 
 * @param {Fact[]|Object[]} facts
 * @returns {Person} This instance
 */
Person.prototype.setFacts = function(facts){
  return this._setArray(facts, 'facts', 'addFact');
};

/**
 * Get facts matching the given type
 * 
 * @param {String} type Fact type
 * @return {Fact[]}
 */
Person.prototype.getFactsByType = function(type){
  return this.getFacts().filter(function(f){
    return f.getType() === type;
  });
};

/**
 * Add a fact
 * 
 * @param {Fact|Object} fact
 * @returns {Person} This instance
 */
Person.prototype.addFact = function(fact){
  return this._arrayPush(fact, 'facts', GedcomX.Fact);
};

/**
 * Export the object as JSON
 * 
 * @return {Object} JSON object
 */
Person.prototype.toJSON = function(){
  return this._toJSON(GedcomX.Subject, Person.jsonProps);
};

module.exports = Person;

1			var GedcomX = require('../'),
2			utils = require('../utils');
3
4			/**
5			* A person.
6			*
7			* @see {@link https://github.com/FamilySearch/gedcomx/blob/master/specifications/json-format-specification.md#person\|GEDCOM X JSON Spec}
8			*
9			* @class
10			* @extends Subject
11			* @param {Object} [json]
12			*/
13			var Person = function(json){
14
15			// Protect against forgetting the new keyword when calling the constructor
16			if(!(this instanceof Person)){
17			return new Person(json);
18			}
19
20			// If the given object is already an instance then just return it. DON'T copy it.
21			if(Person.isInstance(json)){
22			return json;
23			}
24
25			this.init(json);
			0 ignored issues – show Best Practice introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report There is no `return` statement in this branch, but you do return something in other branches. Did you maybe miss it? If you do not want to return anything, consider adding `return undefined;` explicitly. Loading history...
26			};
27
28			Person.prototype = Object.create(GedcomX.Subject.prototype);
29
30			Person._gedxClass = Person.prototype._gedxClass = 'GedcomX.Person';
31
32			Person.jsonProps = [
33			'private',
34			'gender',
35			'names',
36			'facts'
37			];
38
39			/**
40			* Check whether the given object is an instance of this class.
41			*
42			* @param {Object} obj
43			* @returns {Boolean}
44			*/
45			Person.isInstance = function(obj){
46			return utils.isInstance(obj, this._gedxClass);
47			};
48
49			/**
50			* Initialize from JSON
51			*
52			* @param {Object}
			0 ignored issues – show Documentation introduced 2016-10-06 21:41 UTC by Report Bug Copy Issue Report The parameter `*` does not exist. Did you maybe forget to remove this comment? Loading history...
53			* @return {Person} this
54			*/
55			Person.prototype.init = function(json){
56
57			GedcomX.Subject.prototype.init.call(this, json);
58
59			if(json){
60			this.setPrivate(json.private);
61			this.setGender(json.gender);
62			this.setNames(json.names);
63			this.setFacts(json.facts);
64			}
65			return this;
66			};
67
68			/**
69			* Get the private flag
70			*
71			* @returns {Boolean} private
72			*/
73			Person.prototype.getPrivate = function(){
74			return this.private;
75			};
76
77			/**
78			* Set the private flag
79			*
80			* @param {Boolean} isPrivate
81			* @returns {Person} This instance
82			*/
83			Person.prototype.setPrivate = function(isPrivate){
84			this.private = isPrivate;
85			return this;
86			};
87
88			/**
89			* Get the person's gender
90			*
91			* @returns {Gender} gender
92			*/
93			Person.prototype.getGender = function(){
94			return this.gender;
95			};
96
97			/**
98			* Set the person's gender
99			*
100			* @param {Gender} gender
101			* @returns {Person} This instance
102			*/
103			Person.prototype.setGender = function(gender){
104			if(gender){
105			this.gender = GedcomX.Gender(gender);
106			}
107			return this;
108			};
109
110			/**
111			* Check if the person's gender is male.
112			*
113			* @returns {Boolean}
114			*/
115			Person.prototype.isMale = function(){
116			return this.gender && this.gender.getType() === 'http://gedcomx.org/Male';
117			};
118
119			/**
120			* Check if the person's gender is female.
121			*
122			* @returns {Boolean}
123			*/
124			Person.prototype.isFemale = function(){
125			return this.gender && this.gender.getType() === 'http://gedcomx.org/Female';
126			};
127
128			/**
129			* Get the names
130			*
131			* @return {Name[]}
132			*/
133			Person.prototype.getNames = function(){
134			return this.names \|\| [];
135			};
136
137			/**
138			* Set the names
139			*
140			* @param {Name[]\|Object[]} names
141			* @returns {Person} This instance
142			*/
143			Person.prototype.setNames = function(names){
144			return this._setArray(names, 'names', 'addName');
145			};
146
147			/**
148			* Add a name
149			*
150			* @param {NameForm\|Object} name
151			* @returns {Person} This instance
152			*/
153			Person.prototype.addName = function(name){
154			return this._arrayPush(name, 'names', GedcomX.Name);
155			};
156
157			/**
158			* Get the facts
159			*
160			* @return {Fact[]}
161			*/
162			Person.prototype.getFacts = function(){
163			return this.facts \|\| [];
164			};
165
166			/**
167			* Set the facts
168			*
169			* @param {Fact[]\|Object[]} facts
170			* @returns {Person} This instance
171			*/
172			Person.prototype.setFacts = function(facts){
173			return this._setArray(facts, 'facts', 'addFact');
174			};
175
176			/**
177			* Get facts matching the given type
178			*
179			* @param {String} type Fact type
180			* @return {Fact[]}
181			*/
182			Person.prototype.getFactsByType = function(type){
183			return this.getFacts().filter(function(f){
184			return f.getType() === type;
185			});
186			};
187
188			/**
189			* Add a fact
190			*
191			* @param {Fact\|Object} fact
192			* @returns {Person} This instance
193			*/
194			Person.prototype.addFact = function(fact){
195			return this._arrayPush(fact, 'facts', GedcomX.Fact);
196			};
197
198			/**
199			* Export the object as JSON
200			*
201			* @return {Object} JSON object
202			*/
203			Person.prototype.toJSON = function(){
204			return this._toJSON(GedcomX.Subject, Person.jsonProps);
205			};
206
207			module.exports = Person;

rootsdev / gedcomx-js

Person.getFacts A last analyzed 2017-03-29 00:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Person.getFacts A
last analyzed 2017-03-29 00:20 UTC